org.eclipse.vtp.framework.spi
Interface ISessionDescriptor

All Known Implementing Classes:

DeploymentSession

public interface ISessionDescriptor

The descriptor for a session in the process engine.

Author:

Lonnie Pryor

Method Summary

void	clearAttribute(java.lang.String attributeName) Clears the value of the specified session attribute.
java.lang.Object	getAttribute(java.lang.String attributeName) Returns the value of the session attribute with the specified name or null if no such attribute exists.
java.lang.String[]	getAttributeNames() Returns the names of the attributes set in the session.
java.lang.Object	getService(java.lang.String identifier) Returns the service selected for the specified identifier or null if no such service exists.
java.lang.String[]	getServiceIdentifiers() Returns the identifiers of all the externally-provided services.
java.lang.String	getSessionID() Returns the ID of the session being described.
void	setAttribute(java.lang.String attributeName, java.lang.Object attributeValue) Sets the value of the specified session attribute or clears it if the supplied value is null.

Method Detail

getSessionID

java.lang.String getSessionID()

Returns the ID of the session being described.

Returns:

The ID of the session being described.

getServiceIdentifiers

java.lang.String[] getServiceIdentifiers()

Returns the identifiers of all the externally-provided services.

Returns:

The identifiers of all the externally-provided services.

getService

java.lang.Object getService(java.lang.String identifier)
                            throws java.lang.NullPointerException

Returns the service selected for the specified identifier or null if no such service exists.

Parameters:

identifier - The identifier of the service to return.

Returns:

The service selected for the specified identifier or null if no such service exists.

Throws:

java.lang.NullPointerException - If the supplied identifier is null.

getAttributeNames

java.lang.String[] getAttributeNames()

Returns the names of the attributes set in the session.

Returns:

The names of the attributes set in the session.

getAttribute

java.lang.Object getAttribute(java.lang.String attributeName)
                              throws java.lang.NullPointerException

Returns the value of the session attribute with the specified name or null if no such attribute exists.

Parameters:

attributeName - The name of the session attribute to return.

Returns:

The value of the session attribute with the specified name or null if no such attribute exists.

Throws:

java.lang.NullPointerException - If the specified attribute name is null.

setAttribute

void setAttribute(java.lang.String attributeName,
                  java.lang.Object attributeValue)
                  throws java.lang.NullPointerException

Sets the value of the specified session attribute or clears it if the supplied value is null.

Parameters:

attributeName - The name of the session attribute to set.

attributeValue - The value to set the attribute to or null to clear the attribute.

Throws:

java.lang.NullPointerException - If the specified attribute name is null.

clearAttribute

void clearAttribute(java.lang.String attributeName)
                    throws java.lang.NullPointerException

Clears the value of the specified session attribute.

Parameters:

attributeName - The name of the session attribute to clear.

Throws:

java.lang.NullPointerException - If the specified attribute name is null.